Skip to content

docs: add NuGet version badges to the readme - #71

Merged
VisualBean merged 1 commit into
ByteBardOrg:vnextfrom
bielu:docs/nuget-badges
Nov 11, 2026
Merged

VisualBean merged 1 commit into
ByteBardOrg:vnextfrom
bielu:docs/nuget-badges

Conversation

@bielu

@bielu bielu commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Makes the latest published version easy to find from the readme.

  • A NuGet version badge and a downloads badge for ByteBard.AsyncAPI.NET next to the build badge
  • A package table under Install with a live version badge for each package: core, Readers and Bindings

The badges come from shields.io and link to each package's nuget.org page. I checked that all three packages are published (currently 4.0.0).

This README is also packed into the NuGet packages, but its next update there only happens with the next release.

Summary by CodeRabbit

  • Documentation
    • Added NuGet and download-count badges, plus an installation table with version badges for the core, readers, and bindings packages.

@bielu
bielu requested a review from VisualBean as a code owner November 11, 2026 07:28
@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README adds NuGet version and download-count badges. Its Install section lists the core, readers, and bindings packages with version badges.

Changes: Package information

Layer / File(s) Summary
README package badges and installation table
README.md
The README adds NuGet version and download-count badges. The Install section lists the core, readers, and bindings packages with version badges.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to b7fbe

This is a documentation-only change that adds NuGet badges and an install table. It does not alter runtime behavior and is ready to merge.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title clearly and concisely describes the README change: adding NuGet version badges.
Description check Passed The description clearly explains the README changes, badge sources, package links, published version, and NuGet packaging impact. It omits the template headings and the Changelog and Related Issues se…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description clearly explains the README changes, badge sources, package links, published version, and NuGet packaging impact. It omits the template headings and the Changelog and Related Issues sections, but the main required context is complete.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 244e8bf7-fec8-4b46-b2b6-7c2075d099b6
Commits

Reviewing files that changed from the base of the PR and between cf14ea7 and b7fbe00.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@VisualBean
VisualBean merged commit 3dc1870 into ByteBardOrg:vnext Nov 11, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants